Product Services

Product service returns the complete product details and list of attributes and their allowed values. It also provides interactive configuration of attributes and evaluates the risk eligibility. 

GetProducts

Service Name

GetProducts

Service Description

This service is used to get the list of published products. The response includes name, displayName and description of those products.

Input

Request Id (Optional)

Sample Input XML

NA

Output

List of products. Refer:product. 

Sample Output XML

To view a sample XML output file, refer GetProductsResponse.xml

REST URL

Verb: GET; Produces: xml, json http://host:port/ifoundry/api/v1/product/products?requestId={requestId}

GetCoveragesForRisk

Service Name

GetCoveragesForRisk

Service Description

This service is used to get the complete product details including coverages and attributes based on a given contextual parameters such as state, effective date, risk details, and others.

In addition to the product definitions, it also returns a list of IDs of coverages,

and attributes, which upon change can impact other attributes and coverages. These IDs can be leveraged for interactive product configuration.

Input

Product Name, Risks, State, Effective date, and Request Id (Optional)

Refer : ProductRequestDetails

Sample Input XML

To view a sample XML input file, refer GetCoveragesForRiskRequest.xml.

Output

List of Coverages and attributes. 

Refer: ProductResponseDetails

Sample Output XML

To view a sample XML output file, refer GetCoveragesForRiskResponse.xml

REST URL

Verb: POST; Consumes: xml, json; Produces: xml, json http://host:port/ifoundry/api/v1/product/coverages?requestId={requestId} 

 

GetInteractiveProductOptions

Service Name

GetInteractiveProductOptions

Service Description

This service is intended for interactive configuration of attributes, coverages. Using this service applications can fetch and present valid attributes upon user selection of indicated coverage/attributes. Using this service applications can ensure that user is always presented with valid options to select rather than engaging with messages after selection.

  • This service is always used in combination with

    GetCoveragesForRisk service. The co-relation Id sent in the GetCoveragesForRisk is used to maintain transaction context for subsequent calls.

  • Only modified coverages and attributes are exchanged in requests and responses.

Input

Transaction Context, Risks, Co-relation Id and Request Id (Optional)

·     Co-relationId: Unique identifier returned from getCoveragesForRisk ·     RequestEntity[]: Array of modified coverages and attributes.

Refer : InteractiveProductOptionsRequest

Sample Input XML

To view a sample XML input file, refer GetInteractive ProductOptionsRequest.xml.

Output

Modified Coverages, Risks, and attributes

  • Coverages[]: Array of modified coverages after applying product rules.

  • Risks[]: Array of Modified Risks and their attributes.

  • ErrorInfo[]: Error code and message in case if there is service failure or conflict in user selections after applying the product rules.

    Refer : InteractiveProductOptionsResponse

Sample Output XML

To view a sample XML output file, refer

GetInteractiveProductOptionsResponse.xml

REST URL

Verb: POST; Consumes: xml, json; Produces: xml, json http://host:port/ifoundry/api/v1/product/interactiveoptions?requestId={requestId} 

GetModifiedProductOptions

Service Name

GetModifiedProductOptions

Service Description

This service is intended for interactive configuration of attributes. Using this service applications can fetch and present valid attributes upon user selection of indicated coverage/attributes. It ensures that the user is always presented with valid options to select rather than engaging with messages after selection.

  • This service is always used in combination with

    GetCoveragesForRisk service. The co-relation Id sent in the GetCoveragesForRisk is used to maintain transaction context for subsequent calls.

  • Only modified entities (coverages and attributes) are exchanged in requests and responses.

Input

Transaction Context, Risks, Co-relation Id and Request Id (Optional)

·     co-relation Id: Unique identifier returned from getCoveragesForRisk ·     requestEntity[]: Array of modified coverages and attributes.

Refer : InteractiveProductOptionsRequest

Sample Input XML

To view a sample XML input file, refer

GetModifiedProductOptionsRequest.xml. 

Output

Modified Coverages, Risks, and attributes

  • coverages[]: Array of modified coverages after applying product rules.

  • risks[]: Array of Modified Risks and their attributes.

  • errorInfo[]: Error code and message in case if there is service failure or conflict in user selections after applying the product rules. ·     

    Refer : ProductOptionsResponse

Sample Output XML

To view a sample XML output file, refer

GetModifiedProductOptionsResponse.xml

REST URL

Verb: POST; Consumes: xml, json; Produces: xml, json  http://host:port/ifoundry/api/v1/product/modifiedcoverageoptions?requestId={requestId} 

SetCoverageDefaults

Service Name

SetCoverageDefaults

Service Description

This service is intended for configuration of attributes and coverage selection based on the default values. Using this service applications can fetch and present valid attributes upon default selection of indicated coverage/attributes. It ensures that the user is always presented with valid options to select rather than engaging with messages after selection.

  • This service is always used in combination with

    GetCoveragesForRisk service. The co-relation Id sent in the GetCoveragesForRisk is used to maintain transaction context for subsequent calls.

  • Only modified coverages and attributes are exchanged in requests and responses.

Input

Transaction Context, Risks, Co-relation Id and Request Id (Optional)

  • co-relation Id: Unique identifier returned from getCoveragesForRisk

  • requestEntity[]: Array of modified coverages and attributes.

    Refer : InteractiveProductOptionsRequest

     

Sample Input XML

To view a sample XML input file, refer SetCoverageDefaultsRequest.xml.

Output

Modified Coverages, Risks, and attributes

  • coverages[]: Array of modified coverages after applying product rules.

  • risks[]: Array of Modified Risks and their attributes.

  • errorInfo[]: Error code and message in case if there is service failure or conflict in user selections after applying the product rules.

    Refer : InteractiveProductOptionsResponse

Sample Output XML

To view a sample XML output file, refer SetCoverageDefaultsResponse.xml

 

REST URL

Verb: POST ; Consumes: xml, json; Produces: xml, json http://host:port/ifoundry/api/v1/product/coveragedefaults?requestId={requestId} 

DeleteRisk

Service Name

DeleteRisk

Service Description

This service is used to remove a Risk from the generated quote. 

Input

Risk Id, Co-relation Id and Request Id (Optional)

  • riskId: Risk Id to delete.

  • Co-relationId: Unique identifier returned from getCoveragesForRisk 

Sample Input XML

To view a sample XML input file, refer DeleteRiskRequest.xml.

Output

List of Coverages and attributes

Refer : ProductResponseDetails

Sample Output XML

To view a sample XML output file, refer DeleteRiskResponse.xml

REST URL

Verb: DELETE; Produces: xml, json

http://host:port/ifoundry/api/v1/product/risks/{riskName}/correlationId/{correla tionId}?requestId={requestId}

SaveTransactionDetails

Service Name

SaveTransactionDetails

Service Description

This service is used to save the information (coverage selection and attributes) entered by the user. The user can resume from where he stopped.

Input

Co-relation Id: Unique identifier generated for this quote and Request Id (Optional)

Sample Input XML

To view a sample XML input file, refer SaveTransactionDetailsRequest.xml.

Output     

Transaction status. Refer : TransactionDetails

Sample Output XML

To view a sample XML output file, refer SaveTransactionDetailsResponse.xml

REST URL

Verb: POST; Produces: xml, json http://host:port/ifoundry/api/v1/product/transactiondetails/{correlationId}?requestId={requestId}

RollBackTransactionDetails

Service Name

RollBackTransactionDetails

Service Description

This service is used to roll back to the last saved point so as to clear the changes (coverage selections and attributes) made after that save point.

Input

Co-relation Id: Unique identifier generated for this quote, and Request Id (Optional)

Sample Input XML

To view a sample XML input file, refer

RollBackTransactionDetailsRequest.xml.

Output     

List of Coverages and attributes.

Refer : ProductResponseDetails

Sample Output XML

To view a sample XML output file, refer

RollBackTransactionDetailsResponse.xml

REST URL

Verb: POST; Produces: xml, json

http://host:port/ifoundry/api/v1/product/rollbacktransactiondetails/{correlationI d}?requestId={requestId} 

DeleteTransactionDetails

Service Name

DeleteTransactionDetails

Service Description

This service is used to delete the generated quote.

Input

Co-relation Id: Unique identifier generated for this quote and Request Id (Optional)

Sample Input XML

To view a sample XML input file, refer DeleteTransactionDetailsRequest.xml.

Output     

Transaction status. Refer : TransactionDetails

Sample Output XML

To view a sample XML output file, refer DeleteTransactionDetailsResponse.xml

REST URL

Verb: DELETE; Produces: xml, json

http://host:port/ifoundry/api/v1/product/transactiondetails/{correlationI d}?requestId={requestId}

CheckRiskEligibility

Service Name

CheckRiskEligibility

Service Description

This service evaluates the risk eligibility and sets the eligibility status of all the input risks.

Input

Product, Effective date, State, Risks and Request Id. (Optional)

Refer : EligibilityRequest

Sample Input XML

To view a sample XML input file, refer CheckRiskEligibilityRequest.xml.

Output     

List of Risks with eligibility status. Refer : EligibilityDetails

Sample Output XML

To view a sample XML output file, refer CheckRiskEligibilityResponse.xml

REST URL

Verb: POST; Consumes: xml, json; Produces: xml, json  http://host:port/ifoundry/api/v1/product/checkEligibility?requestId={requestId} 

GetDomainValues

Service Name

GetDomainValues

Service Description

This service returns the list of attributes and their allowed values for a given Coverage/Risk/Form/Endorsement, product, state, and effective date.

Input

Product, Effective date, State, Coverage/Risk/Form/Endorsement, Request Id(optional)

Refer : DomainValuesRequest

Sample Input XML

To view a sample XML input file, refer GetDomainValuesRequest.xml.

Output

List of attributes and their allowed values

Refer : DomainTableResponse

Sample Output XML

To view a sample XML output file, refer GetDomainValuesResponse.xml

REST URL

Verb: POST; Consumes: xml, json; Produces: xml, json  http://host:port/ifoundry/api/v1/domaintable/domainvalues?requestId={requestId}

GetDomainTableMappings

Service Name

getDomainTableMappings

Service Description

This service returns the list of domain table (product choices) mappings for all the factor groups (Risk, Coverage, Form, Endorsement) for a given product, state, and effective date. It returns associated attributes for every attribute in a given product variation. An application with dynamic screens can leverage this API to identify the associated fields that need to be sent along with the changed field to fetch dependent values.

Input

Product Name, Effective date, State, and Request Id(optional)

Refer : ContextInfo

Sample Input XML

To view a sample XML input file, refer GetDomainTableMappingsRequest.xml.

Output

List of attributes and their associations

  • associations[]: Array of attribute associations

  • errorInfo: service error code and message

    Refer : MappingResponse

Sample Output XML

To view a sample XML output file, refer GetDomainTableMappingsResponse.xml

REST URL

Verb: POST; Consumes: xml, json; Produces: xml, json  http://host:port/ifoundry/api/v1/domaintable/mappings?requestId={requestId}

GetResolvedDomainValues

Service Name

getResolvedDomainValues

Service Description

This service returns the dependent attributes (product choices) and the based on the given input attributes, state, and effective date.

Input

Product, Effective date, State, Input Attributes and Request Id(optional)

  • contextInfo: Product, Effective date, State

  • factorInfo[]: Array of input attribute and their selected values.

    Refer : DomainTableRequest

Sample Input XML

To view a sample XML input file, refer

GetResolvedDomainValuesRequest.xml.

Output

List of dependent attributes and their values,

·     factorInfo[]: Array of attributes with values ·     errorInfo: service error code and message.

Refer : DomainTableResponse

 

 

Sample Output XML

To view a sample XML output file, refer GetResolvedDomainValuesResponse.xml

 

 

REST URL

Verb: POST; Consumes: xml, json; Produces: xml, json http://host:port/ifoundry/api/v1/domaintable/resolveddomainvalues?requestId={requestId} 

GetDomainValuesByName

Service Name

getDomainValuesByName

Service Description

This service returns the dependent attributes (product choices) and the based on the given input attributes, state, and effective date.

Input

Product, Effective date, State, Input Attributes and Request Id(optional)

  • contextInfo: Product, Effective date, State

  • factorInfo[]: Array of input attribute and their selected values.

  • tableName: DomainTable name to execute

    Refer : SpecificDomainTableRequest

Sample Input XML

To view a sample XML input file, refer GetDomainValuesByNameRequest.xml.

Output

List of dependent attributes and their values

    factorInfo[]: Array of attributes with values ·     errorInfo: service error code and message.

Refer : DomainTableResponse

Sample Output XML

To view a sample XML output file, refer GetDomainValuesByNameResponse.xml

REST URL

Verb: POST; Consumes: xml, json; Produces: xml, json http://host:port/ifoundry/api/v1/domaintable/domainvaluesbyname?requestId={requestId} 

ValidateDomainValues

Service Name

validateDomainValues

Service Description

This service is used to validate the attribute values of Risk and RiskExtensions sent as request and difference attributes are returned along with the original risk and risk extensions in response.

 

Input

Risk, RiskExtension, ContextInfo and Request Id(optional)

  • contextInfo: Product, Effective date, PlanDeterminationFactors

  • Risk[]: Array of risk

  • RiskExtension[]: Array of risk extension

    Refer : ValidateDomainValuesRequest

Sample Input XML

To view a sample XML input file, refer ValidateDomainValuesRequest.xml.

Output

List of differnce attributes and their values

Risk[]: Array of risk and input attribute and their selected values.

RiskExtension[]: Array of risk extension and input attribute and their  selected values.

AttributeInfo[]: Array of differnce attributes with values

errorInfo: service error code and message.

Refer : ValidateDomainValuesResponse

Sample Output XML

To view a sample XML output file, refer ValidateDomainValuesResponse.xml

REST URL

Verb: POST; Consumes: xml, json; Produces: xml, json http://host:port/ifoundry/api/v1/domaintable/validatedomainvalues?requestId={requestId}